home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / bbs_misc / kbbs20q.zip / KBBSMENU.DOC < prev    next >
Text File  |  1995-12-13  |  7KB  |  209 lines
  1.  
  2.  
  3.   KBBSMENU DOCUMENTATION
  4.   ----------------------
  5.  
  6.  
  7.   IMPORTANT INFORMATION
  8.  
  9.   By installing KBBS on your system, you agree to the following
  10.   terms and conditions:
  11.  
  12.   ANDERSON RESEARCH MAKES NO WARRANTY OF ANY KIND EITHER EXPRESSED
  13.   OR IMPLIED, INCLUDING, BUT NOT LIMITED TO IMPLIED WARRANTIES OF
  14.   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  15.  
  16.   LIMITATION OF LIABILITY - In no event shall Anderson Research be
  17.   liable for any special, indirect, consequential, exemplary, or
  18.   incidental damages whatsoever (including, without limitation,
  19.   damage for loss of profits, loss of information, loss of
  20.   goodwill, or other pecuniary loss) whether based in contract,
  21.   tort, negligence, strict liability, or otherwise, even if
  22.   Anderson Research has been advised of the possibility of such
  23.   damages.
  24.  
  25.   This document contains propritetary information which is
  26.   protected by copyright.  No part of this document may be
  27.   photocopied, reprinted, or translated without the prior written
  28.   consent of Anderson Research.
  29.  
  30.   The information in this document, and all included documents, is
  31.   subject to change without notice.
  32.  
  33.  
  34.   TEST VERSION
  35.   ------------
  36.  
  37.     This is an early release version of KBBSMENU that will be included
  38.     with KBBS vZ.21.  Please test and report bugs ASAP... thanks.
  39.  
  40.  
  41.   OVERVIEW
  42.   --------
  43.  
  44.     KBBSMENU is a separate utility now included with the regular
  45.     KBBS releases that allows sysops to effortlessly add highlight
  46.     bar menu support to their existing ANSI menus.
  47.  
  48.     This program does not draw menus-- you will still need to use
  49.     your ANSI draw package to produce the color ANSI menu that this
  50.     program will modify.
  51.  
  52.     NOTE:  This was a quickly-written-by-demand program, so although
  53.            it does the job, future releases will have more features
  54.            and more capabilities (such as mouse support).
  55.  
  56.  
  57.   INSTALLATION
  58.   ------------
  59.  
  60.     Copy KBBSMENU.EXE into your KBBS directory... the same directory
  61.     where KBBSEXEC.EXE resides.
  62.  
  63.  
  64.   TECHNICAL INFORMATION
  65.   ---------------------
  66.  
  67.     32 LINE LIMIT
  68.  
  69.       Because of the way KBBS displays menu files, you are limited to
  70.       an ANSI menu screen of 23 lines in length.  This limitation will
  71.       be done away with in a future release.
  72.  
  73.  
  74.     OPTIMIZATION
  75.  
  76.       ANSI screens are saved in an optimized form for display by
  77.       KBBS systems.  Once you have added highlight bars to a screen,
  78.       you won't be able to modify the screen with your ANSI draw
  79.       package.  KBBSMENU saves the original .ANS file in a directory
  80.       named ORIGINAL under your TEXT path.
  81.  
  82.  
  83.   STEP BY STEP EXAMPLE
  84.   --------------------
  85.  
  86.     For the most part, it's pretty self explanatory.  The following
  87.     steps are an example of how to add highlight bars to a menu
  88.     MAINMENU.ANS.
  89.  
  90.       1. Make sure MAINMENU.ANS is in your TEXT path.  That is where
  91.          KBBSMENU looks for all .ANS files, although you can save
  92.          them to another location.  (This will be enhanced later,
  93.          also.)
  94.  
  95.       2. Type KBBSMENU at the prompt.  A list of .ANS files will
  96.          be displayed.  Select MAINMENU.ANS.  KBBSMENU will then
  97.          display the screen in a window.
  98.  
  99.       3. If you previously added highlight bars to this ANSI menu
  100.          screen, a picklist will list those highlight bars.  Otherwise
  101.          it will display "No highlight bars defined in this menu."
  102.  
  103.       4. TO ADD A HIGHLIGHT BAR, press INSERT.  The picklist will
  104.          disappear, and a highlighted block will appear in the upper
  105.          left hand corner of the screen.  The following keys allow
  106.          you to position and modify the bar:
  107.  
  108.            ARROW KEYS           Move the bar around
  109.  
  110.            CTRL-LEFT and
  111.            CTRL-RIGHT           Re-size the bar
  112.  
  113.            PAGEUP and
  114.            PAGEDOWN             Change the foreground color of the bar
  115.  
  116.            CTRL-PAGEUP and
  117.            CTRL-PAGEDOWN        Change the background color of the bar
  118.  
  119.            ENTER                Accept the bar in its position and
  120.                                 begin editing the attributes for that bar
  121.  
  122.                                 At this point you must choose a "grid"
  123.                                 position for the bar, and the HotKey that
  124.                                 the bar activates when selected in the
  125.                                 KBBS menu online. See "About Grid
  126.                                 Positions" below for more information.
  127.  
  128.            ESCAPE               Abort-- return to the picklist
  129.  
  130.  
  131.       5. TO DELETE A HIGHLIGHT BAR, press DELETE on the bar you wish
  132.          to delete.  KBBSMENU will prompt you before deleting the bar.
  133.  
  134.       6. TO EDIT AN EXISTING BAR, press ENTER on the bar you wish to
  135.          delete.  At this point you may change the position/color of the
  136.          bar similar to #4 above, then you may edit the attributs of that
  137.          bar.
  138.  
  139.       7. TO SAVE/EXIT, press ESCAPE or F10.  You will then be prompted
  140.          whether or not you wish to save the screen or abort without
  141.          saving.
  142.  
  143.     That's it!  You can now define the ANSI display menu in your menu
  144.     tree or MENU() commands and KBBS will activate highlight bars in
  145.     the positions you chose.
  146.  
  147.  
  148.   ABOUT GRID POSITIONS
  149.   --------------------
  150.  
  151.     KBBS allows you to choose the "grid" position for each menu.  This
  152.     gives you complete control of where the highlight bar moves when
  153.     the arrow keys are pressed.  Examine the following grid table:
  154.  
  155.  
  156.                   Columns
  157.  
  158.                 1  2  3  4  5  6  7  8
  159.  
  160.              1
  161.         Rows
  162.              2      <-- left and right move this way -->
  163.  
  164.              3   ^
  165.                  |
  166.              4
  167.                  up and down move this way
  168.              5
  169.  
  170.              6   |
  171.                  v
  172.              7
  173.              .
  174.              .
  175.              .
  176.  
  177.     No matter where the highlight bar is on the ANSI display, each
  178.     highlight bar is assigned a "Grid" position.  This tells KBBS
  179.     what relationship each bar is to the rest.  The left and right
  180.     arrows will always switch to highlight bars along the grid
  181.     columns, and the up and down arrows will always switch to
  182.     highlight bars along the rows.  They don't have to occupy
  183.     grid positions next to each other-- if you have a highlight
  184.     bar defined as Row 1 Col 1, another as Row 1 Col 3, with none
  185.     defined in Row 1 Col 2, a right arrow press will move the
  186.     highlight bar from 1:1 to 1:3.
  187.  
  188.  
  189.   COMMENTS AND BUG REPORTS
  190.   ------------------------
  191.  
  192.     Please comment and report bugs in the ARI_KBBS conference, or
  193.     send netmail to
  194.  
  195.       Keith Anderson at 1:312/100 (Fidonet)
  196.                         888:7101/1 (ARInet)
  197.  
  198.       Internet e-mail:
  199.  
  200.         keith.anderson@mtnswest.com
  201.         keith.anderson#ARI@hdh.com
  202.  
  203.     Or call Megalopolis BBS:
  204.  
  205.       801-489-7910  28.8
  206.       801-489-1947  14.4
  207.       801-489-1946  12.0
  208.  
  209.